Adding functionality to config preferred authschemeProvider #6083

RanVaknin · 2025-05-02T20:07:35Z

Motivation and Context

Previously, when multiple auth schemes were available for an operation, the SDK would choose the first one defined in the service model. This PR implements the auth scheme preference configuration that allows users to specify their preferred authentication schemes in order of preference when multiple auth schemes are supported.

Example usage:

// Via client configuration in code
MyServiceClient client = MyServiceClient.builder()
    .authSchemeProvider(MyServiceAuthSchemeProvider.builder()
        .withPreferredAuthSchemes(Arrays.asList("sigv4", "sigv4a"))
        .build())
    .build();

// Via JVM properties:
// in code
System.setProperty("aws.authSchemePreference", "sigv4,sigv4a");
// or as a cmd line argument
java -Daws.authSchemePreference=sigv4,sigv4a -jar your-application.jar

// Via Environment variable:
export AWS_AUTH_SCHEME_PREFERENCE=sigv4,sigv4a

// Via AWS config file (~/.aws/config):
[default]
auth_scheme_preference = sigv4,sigv4a

Modifications

[Modified] client builders to read and apply auth scheme preferences
[Modified] the auth scheme resolution logic to respect user preferences while maintaining backward compatibility
[Added] AuthSchemePreferenceProvider class to resolve auth scheme preferences from various sources:
- Client configuration
- JVM system properties (aws.authSchemePreference)
- Environment variables (AWS_AUTH_SCHEME_PREFERENCE)
- AWS config file (auth_scheme_preference)
[Added] code generation support through PreferredAuthSchemeProviderSpec to generate service-specific auth scheme providers

Testing

AuthSchemePreferenceProviderTest verifies proper parsing of auth scheme preferences from different formats (spaces, tabs, etc.)
PreferredAuthSchemeProviderTest to test the reordering of auth schemes according to preferences
comprehensive test cases for preference resolution from multiple sources, verifying proper precedence:
Stubbed functional test with mock services to verify the selected auth scheme matches the expected preference in actual requests

sonarqubecloud · 2025-05-23T21:34:56Z

Quality Gate failed

Failed conditions
69.3% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

zoewangg · 2025-05-27T17:08:22Z

...st/resources/software/amazon/awssdk/codegen/poet/auth/scheme/query-auth-scheme-provider.java

@@ -1,27 +1,15 @@
-/*


Is there any reason we are removing copyright?

zoewangg · 2025-05-27T17:13:26Z

...st/resources/software/amazon/awssdk/codegen/poet/auth/scheme/query-auth-scheme-provider.java

+        return new QueryAuthSchemeProviderBuilder();
+    }
+
+    interface Builder {


Can we make it extend CopyableBuilder? https://github.com/aws/aws-sdk-java-v2/blob/master/docs/design/ClientConfiguration.md

zoewangg · 2025-05-27T17:18:00Z

...aws-core/src/main/java/software/amazon/awssdk/awscore/auth/AuthSchemePreferenceProvider.java

+import software.amazon.awssdk.utils.Lazy;
+
+@SdkProtectedApi
+public class AuthSchemePreferenceProvider {


zoewangg · 2025-05-27T17:19:35Z

...aws-core/src/main/java/software/amazon/awssdk/awscore/auth/AuthSchemePreferenceProvider.java

+import software.amazon.awssdk.utils.Lazy;
+
+@SdkProtectedApi
+public class AuthSchemePreferenceProvider {


Can we add some tests for this class? Example: https://github.com/aws/aws-sdk-java-v2/blob/master/core/sdk-core/src/test/java/software/amazon/awssdk/core/internal/checksums/RequestChecksumCalculationResolverTest.java

zoewangg · 2025-05-27T17:21:46Z

...rc/test/java/software/amazon/awssdk/services/multiauth/AuthSchemePreferenceProviderTest.java

+            try {
+                client.multiAuthWithOnlySigv4aAndSigv4(MultiAuthWithOnlySigv4AAndSigv4Request.builder().build());
+            } catch (AutSchemeCapturingInterceptor.CaptureException e) {
+                // expected
+            }


Can we use assertThatThrownBy

zoewangg · 2025-05-28T03:22:51Z

...aws-core/src/main/java/software/amazon/awssdk/awscore/auth/AuthSchemePreferenceProvider.java

+    private static List<String> parseAuthSchemeList(String unformattedList) {
+        if (unformattedList == null) {
+            return Collections.emptyList();
+        }
+
+        unformattedList = unformattedList.replaceAll("\\s+", "");
+        String[] splitByTabs = unformattedList.split("\t");
+        String finalFormat = String.join("", splitByTabs);
+        return Arrays.asList(finalFormat.split(","));
+    }


Would this work?"\\s+" should handle tab.

private static List<String> parseAuthSchemeList(String unformattedList) { if (unformattedList == null) { return Collections.emptyList(); } return Arrays.asList(unformattedList.replaceAll("\\s+", "").split(",")); }

zoewangg · 2025-05-28T03:23:42Z

...in/java/software/amazon/awssdk/codegen/poet/auth/scheme/PreferredAuthSchemeProviderSpec.java

+import software.amazon.awssdk.codegen.poet.PoetUtils;
+import software.amazon.awssdk.utils.CollectionUtils;
+
+public class PreferredAuthSchemeProviderSpec implements ClassSpec {


Can we add test case for this class?

zoewangg · 2025-05-28T03:24:24Z

...in/java/software/amazon/awssdk/codegen/poet/auth/scheme/PreferredAuthSchemeProviderSpec.java

+        b.addStatement("String candidateSchemeName = candidate.schemeId().contains(\"#\") ? " +
+                       "candidate.schemeId().split(\"#\")[1] : candidate.schemeId()");
+        b.addStatement("return candidateSchemeName.equals(preferredSchemeId)");


Just curious, why do we need to handle# here?

zoewangg · 2025-05-28T03:33:00Z

...rc/test/java/software/amazon/awssdk/services/multiauth/AuthSchemePreferenceProviderTest.java

+    }
+
+    @ParameterizedTest
+    @MethodSource("schemeParsingCases")


nit: can we add a test name for each parameter?

zoewangg · 2025-05-28T03:35:49Z

...st/resources/software/amazon/awssdk/codegen/poet/auth/scheme/query-auth-scheme-provider.java

+        return new QueryAuthSchemeProviderBuilder();
+    }
+
+    interface Builder {


Missing javadoc and NotThreadSafe annotation`

RanVaknin added 2 commits May 4, 2025 19:22

Adding functionality to config preferred authschemeProvider

fc6d3e6

adding test coverage

f18fcc2

RanVaknin force-pushed the rvaknin/auth-schem-preference-config branch from 362e5f3 to f18fcc2 Compare May 5, 2025 02:22

RanVaknin and others added 10 commits May 4, 2025 19:57

fix formatting checkstyle

72b1386

Added changelog

39dc9e4

Adding test coverage

f31aa2a

Merge branch 'master' into rvaknin/auth-schem-preference-config

c20030b

Merge branch 'master' into rvaknin/auth-schem-preference-config

17240db

Use SdkSystemSetting for both env and system

a0094ed

Add profiles to service pom

f46a773

Fix test

6ae2294

Fix protocol test dependencies

4ae9a44

Remove dependency on profiles (use option get in generated code instead)

a9e1a08

alextwoods mentioned this pull request May 23, 2025

Add Environment Token support #6130

Draft

12 tasks

alextwoods added 3 commits May 23, 2025 12:27

Fix checkstyle

73e0564

Move AuthSchemePreferenceProvider out of internal module

e20c041

More checkstyle fixes

cb2d5a0

RanVaknin marked this pull request as ready for review May 26, 2025 04:51

RanVaknin requested a review from a team as a code owner May 26, 2025 04:51

zoewangg requested changes May 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding functionality to config preferred authschemeProvider #6083

Adding functionality to config preferred authschemeProvider #6083

RanVaknin commented May 2, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented May 23, 2025

Uh oh!

zoewangg May 27, 2025

Uh oh!

zoewangg May 27, 2025

Uh oh!

zoewangg May 27, 2025

Uh oh!

zoewangg May 27, 2025

Uh oh!

zoewangg May 27, 2025

Uh oh!

zoewangg May 28, 2025

Uh oh!

zoewangg May 28, 2025

Uh oh!

zoewangg May 28, 2025

Uh oh!

zoewangg May 28, 2025

Uh oh!

zoewangg May 28, 2025

Uh oh!

Uh oh!

Adding functionality to config preferred authschemeProvider #6083

Are you sure you want to change the base?

Adding functionality to config preferred authschemeProvider #6083

Conversation

RanVaknin commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Example usage:

Modifications

Testing

Uh oh!

sonarqubecloud bot commented May 23, 2025

Quality Gate failed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

RanVaknin commented May 2, 2025 •

edited

Loading